home *** CD-ROM | disk | FTP | other *** search
/ Die Speccy' 97 / Die Speccy' 97.iso / amiga_system / the_aminet / comm / mebbs / rfslog100.lha / RFSLog.Doc < prev   
Text File  |  1995-09-23  |  5KB  |  120 lines
  1.                                   RFSLog
  2.  
  3.                                Version 1.00
  4.  
  5.                         by: Steve Robbins [M3014]
  6.  
  7.  
  8. Distribution:
  9.  
  10.      RFSLog is copyrighted and is distributed as freely distributable. You
  11. may upload it to any BBS or service like Genie or Portal that you wish, it 
  12. may be distributed on disk as long as the charge for such a disk does not 
  13. exceed reasonable cost for the magnetic media and shipping/handling charges. 
  14. All distributions must be in original form. No warranties are implied or 
  15. expressed with regard to the total fitness or useability of RFSLog for any 
  16. particular purpose. All risks are that of the user.
  17.  
  18.  
  19. What it is:
  20.  
  21.     RFSLog is a program that allows you to backup all of your log files
  22. automatically each night. Although this could be done easily with a
  23. script, RFSLog comes with some extra capabilities. First off there are many
  24. ways to rename the file once you back it up. This can be done in five
  25. different ways: Delete the file, copy the file, name the file so it is
  26. unique for a one week period, name the file so it is unique for a one
  27. month period, or name the file so that it is unique for a one year period.
  28. Also you have the option of automatically placing the backed up file in an
  29. archive that is named for the current month.
  30.  
  31.  
  32. Installation:
  33.  
  34.     Copy RFSLog to your MEBBSNet:c directory and place RFSLog.cfg in your
  35. MEBBSNet:ConfigFiles directory.
  36.  
  37.   
  38. Running RFSLog:
  39.  
  40.     You simply want to place the command "RFSLog" in a script that is
  41. executed each night preferably before midnight. I run mine at 11:58 PM.
  42. RFSLog will then copy the files to the designated directories with the
  43. names extended by the date if you have configured it that way. Take care
  44. to place RFSLog after any programs in your script that scan the log and
  45. pull information out (for example: Usage by Larry Cloud). If you run it
  46. after midnite then you just have to keep in mind that every file will have
  47. info in it from the date previous to the one that is in the filename.
  48.  
  49.  
  50. Configuration:
  51.  
  52.     Each file that you want backed up will require five entries in the
  53. configuration file in this manner:
  54.  
  55. ; MEBBSNet Line 1
  56. BBS:
  57. bbs:backups/
  58. MEBBSNet1.log
  59. YEAR
  60. NOARCHIVE
  61.  
  62. After the comment, the first line is for the path that the log file
  63. currently resides in. This must end in a trailing slash or colon. The
  64. second line is for the path that the backup file will go to. This also
  65. must end in a trailing slash or colon. The third line is the name of the
  66. log to be backed up. The fourth line is for the type of backup this will
  67. be, these are explained below. The fifth line will either contain ARCHIVE
  68. or NOARCHIVE. This designates whether or not you want the backup file
  69. placed in an archive. Both lines 4 and 5 must be in all caps.
  70.  
  71.  
  72. Five Types of backups:
  73.  
  74. 1)  Delete - Simply deletes the log file.
  75. 2)  Single - This copies the file to the backup directory without
  76. modifying the name.
  77. 3)  Year - This copies the file to the backup directory and modifies the
  78. name to give it a unique name for a one year period. The month and day
  79. will be appended in numerical format. For instance if the current date is
  80. May 19th and you are backing up your MEBBSNet1.log then the backup file
  81. will be named MEBBSNet1.log.0519.
  82. 4)  Month - This copies the file to the backup directory and modifies the
  83. name to give it a unique name for a one month period. The day will be 
  84. appended in numerical format. For instance if the current date is
  85. the 19th and you are backing up your MEBBSNet1.log then the backup file
  86. will be named MEBBSNet1.log.19.
  87. 5)  Day - This copies the file to the backup directory and modifies the
  88. name to give it a unique name for a one week period. The day of the week
  89. will be appended in text format. For instance if the current day is
  90. Saturday and you are backing up your MEBBSNet1.log then the backup file
  91. will be named MEBBSNet1.log.Saturday.
  92.  
  93.  
  94. Assumptions:
  95.    
  96.    - If you select SINGLE or DELETE then NOARCHIVE is automatically
  97. assumed.
  98.    - If you select DELETE than the backup path is ignored.
  99.    - All five lines must have some entry in them even if they are not
  100. used.
  101.    - Comments can be placed in the configuration file by putting a
  102. semi-colon at the beginning of the line.
  103.    - Blank lines are allowed.
  104.    - After any file is backed up or deleted then it is replaced with a 0
  105. byte file of the same name. This is due to some logs that aren't used if a
  106. file doesn't already exist (Download.log, Call.log).
  107.  
  108.  
  109.  
  110. EMail: SRobbins@ix.netcom.com
  111.  
  112. Fido: 1:360/29
  113.  
  114.  
  115.  
  116. History
  117.  
  118. Version 1.00
  119.    - Initial release
  120.